Overhaul IPFS Troubleshooting guides with new content and structure #2046
Conversation
remove pl-diagnose which isn't maintained and operated
🚀 Build Preview on IPFS ready
|
2color
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## File transfers | ||
|
|
||
| To start, make sure that Kubo is running on both machines. To verify, run `ipfs id` on each machine and check if the `Addresses` field has anything in it. If it says `null`, then your node is not online, and you will need to run `ipfs daemon`. |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
|
|
||
| ### Checking for existing connections | ||
|
|
||
| The first thing to do is to double-check that both nodes are, in fact, running and online. To do this, run `ipfs id` on each machine. If both nodes show some addresses (like the example below), then your nodes are online. |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
|
|
||
| If you see a lot of multiaddrs, you can try to use the `ipfs swarm connect <multiaddr>` command to connect to `node a` from `node b`. This command will return a list of NAT traversal methods that your node supports. If your node supports UPnP or NAT-PMP, you can try to enable them on the router of `node a` and retry the process. Otherwise, you can try manually connecting `node a` to `node b`. | ||
|
|
||
| ### Checking connectivity with the identify protocol |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The verb ‘identify’ does not usually follow articles like ‘the’. Check that ‘identify’ is spelled correctly; using ‘identify’ as a noun may be non-standard. (A_INFINITIVE[2])
Suggestions: to identify, they identify
URL: https://languagetool.org/insights/post/verbs-as-nouns/
Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=2
Category: GRAMMAR
|
|
||
| ### Checking connectivity with the identify protocol | ||
|
|
||
| To check if your node can connect to `node a`, try running the `ipfs id <peerId>` command: with the peer ID of `node a` on `node b`: |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
| To check if your node can connect to `node a`, try running the `ipfs id <peerId>` command: with the peer ID of `node a` on `node b`: | ||
|
|
||
| ```shell | ||
| ipfs id <peerId> |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
| 1. goroutine dump: | ||
|
|
||
| ```shell | ||
| curl localhost:5001/debug/pprof/goroutine\?debug=2 > ipfs.stacks |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Stacks, stacks
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
| 1. heap trace dump: | ||
|
|
||
| ```shell | ||
| curl localhost:5001/debug/pprof/heap > ipfs.heap |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Heap, heap
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
| 1. memory statistics. In JSON see `memstats` object: | ||
|
|
||
| ```shell | ||
| curl localhost:5001/debug/vars > ipfs.vars |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Vars, vars
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
|
|
||
| ### Analyzing the CPU Profile | ||
|
|
||
| The go team wrote an [excellent article on profiling go programs](http://blog.golang.org/profiling-go-programs). If you've already gathered the above information, you can skip down to where they start talking about `go tool pprof`. My go-to method of analyzing these is to run the `web` command, which generates an SVG dotgraph and opens it in your browser. This is the quickest way to easily point out where the hot spots in the code are. |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The verb ‘is’ is singular. Did you mean: “this is” or “these are”? (SINGULAR_VERB_AFTER_THESE_OR_THOSE[1])
Suggestions: this is, these are
Rule: https://community.languagetool.org/rule/show/SINGULAR_VERB_AFTER_THESE_OR_THOSE?lang=en-US&subId=1
Category: GRAMMAR
What